home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / libkcal / incidence.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-02-13  |  13.9 KB  |  487 lines
  1. /*
  2.     This file is part of libkcal.
  3.  
  4.     Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
  5.     Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
  6.  
  7.     This library is free software; you can redistribute it and/or
  8.     modify it under the terms of the GNU Library General Public
  9.     License as published by the Free Software Foundation; either
  10.     version 2 of the License, or (at your option) any later version.
  11.  
  12.     This library is distributed in the hope that it will be useful,
  13.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15.     Library General Public License for more details.
  16.  
  17.     You should have received a copy of the GNU Library General Public License
  18.     along with this library; see the file COPYING.LIB.  If not, write to
  19.     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20.     Boston, MA 02110-1301, USA.
  21. */
  22. #ifndef INCIDENCE_H
  23. #define INCIDENCE_H
  24.  
  25. #include <qdatetime.h>
  26. #include <qstringlist.h>
  27. #include <qvaluelist.h>
  28.  
  29. #include "recurrence.h"
  30. #include "alarm.h"
  31. #include "attachment.h"
  32. #include "libkcal_export.h"
  33.  
  34. #include "incidencebase.h"
  35. #include <kdepimmacros.h>
  36.  
  37. namespace KCal {
  38.  
  39.  
  40. /**
  41.   This class provides the base class common to all calendar components.
  42. */
  43. class LIBKCAL_EXPORT Incidence : public IncidenceBase, public Recurrence::Observer
  44. {
  45.   public:
  46.     /**
  47.       This class implements a visitor for adding an Incidence to a resource
  48.       supporting addEvent(), addTodo() and addJournal() calls.
  49.     */
  50.     template<class T>
  51.     class AddVisitor : public IncidenceBase::Visitor
  52.     {
  53.       public:
  54.         AddVisitor( T *r ) : mResource( r ) {}
  55.  
  56.         bool visit( Event *e ) { return mResource->addEvent( e ); }
  57.         bool visit( Todo *t ) { return mResource->addTodo( t ); }
  58.         bool visit( Journal *j ) { return mResource->addJournal( j ); }
  59.  
  60.       private:
  61.         T *mResource;
  62.     };
  63.  
  64.     /**
  65.       This class implements a visitor for deleting an Incidence from a resource
  66.       supporting deleteEvent(), deleteTodo() and deleteJournal() calls.
  67.     */
  68.     template<class T>
  69.     class DeleteVisitor : public IncidenceBase::Visitor
  70.     {
  71.       public:
  72.         DeleteVisitor( T *r ) : mResource( r ) {}
  73.  
  74.         bool visit( Event *e ) { mResource->deleteEvent( e ); return true; }
  75.         bool visit( Todo *t ) { mResource->deleteTodo( t ); return true; }
  76.         bool visit( Journal *j ) { mResource->deleteJournal( j ); return true; }
  77.  
  78.       private:
  79.         T *mResource;
  80.     };
  81.  
  82.     /** Enumeration for describing an event's status.  */
  83.     enum Status {
  84.         StatusNone, StatusTentative, StatusConfirmed, StatusCompleted,
  85.         StatusNeedsAction, StatusCanceled, StatusInProcess, StatusDraft,
  86.         StatusFinal,
  87.         StatusX   // indicates a non-standard status string
  88.     };
  89.  
  90.     /** enumeration for describing an event's secrecy. */
  91.     enum { SecrecyPublic = 0, SecrecyPrivate = 1, SecrecyConfidential = 2 };
  92.  
  93.     typedef ListBase<Incidence> List;
  94.  
  95.     Incidence();
  96.     Incidence( const Incidence & );
  97.     ~Incidence();
  98.  
  99.     Incidence& operator=( const Incidence &i );
  100.     bool operator==( const Incidence & ) const;
  101.  
  102.     /**
  103.       Return copy of this object. The returned object is owned by the caller.
  104.     */
  105.     virtual Incidence *clone() = 0;
  106.  
  107.     /**
  108.       Set readonly state of incidence.
  109.  
  110.       @param readonly If true, the incidence is set to readonly, if false the
  111.                       incidence is set to readwrite.
  112.     */
  113.     void setReadOnly( bool readonly );
  114.  
  115.     /** Set whether the incidence floats, i.e. has a date but no time attached to it. */
  116.     void setFloats( bool f );
  117.  
  118.     /**
  119.       Recreate event. The event is made a new unique event, but already stored
  120.       event information is preserved. Sets uniquie id, creation date, last
  121.       modification date and revision number.
  122.     */
  123.     void recreate();
  124.  
  125.     /**
  126.       Set creation date.
  127.     */
  128.     void setCreated( const QDateTime & );
  129.     /**
  130.       Return time and date of creation.
  131.     */
  132.     QDateTime created() const;
  133.  
  134.     /**
  135.       Set the number of revisions this event has seen.
  136.     */
  137.     void setRevision( int rev );
  138.     /**
  139.       Return the number of revisions this event has seen.
  140.     */
  141.     int revision() const;
  142.  
  143.     /**
  144.       Set starting date/time.
  145.     */
  146.     virtual void setDtStart( const QDateTime &dtStart );
  147.     /**
  148.       Return the incidence's ending date/time as a QDateTime.
  149.     */
  150.     virtual QDateTime dtEnd() const  { return QDateTime(); }
  151.  
  152.     /**
  153.       Set the long description.
  154.     */
  155.     void setDescription( const QString &description );
  156.     /**
  157.       Return long description.
  158.     */
  159.     QString description() const;
  160.  
  161.     /**
  162.       Set short summary.
  163.     */
  164.     void setSummary( const QString &summary );
  165.     /**
  166.       Return short summary.
  167.     */
  168.     QString summary() const;
  169.  
  170.     /**
  171.       Set categories.
  172.     */
  173.     void setCategories( const QStringList &categories );
  174.     /**
  175.       Set categories based on a comma delimited string.
  176.     */
  177.     void setCategories(const QString &catStr);
  178.     /**
  179.       Return categories as a list of strings.
  180.     */
  181.     QStringList categories() const;
  182.     /**
  183.       Return categories as a comma separated string.
  184.     */
  185.     QString categoriesStr() const;
  186.  
  187.     /**
  188.       Point at some other event to which the event relates. This function should
  189.       only be used when constructing a calendar before the related Incidence
  190.       exists.
  191.     */
  192.     void setRelatedToUid(const QString &);
  193.     /**
  194.       What event does this one relate to? This function should
  195.       only be used when constructing a calendar before the related Incidence
  196.       exists.
  197.     */
  198.     QString relatedToUid() const;
  199.     /**
  200.       Point at some other event to which the event relates
  201.     */
  202.     void setRelatedTo(Incidence *relatedTo);
  203.     /**
  204.       What event does this one relate to?
  205.     */
  206.     Incidence *relatedTo() const;
  207.     /**
  208.       All events that are related to this event.
  209.     */
  210.     Incidence::List relations() const;
  211.     /**
  212.       Add an event which is related to this event.
  213.     */
  214.     void addRelation(Incidence *);
  215.     /**
  216.       Remove event that is related to this event.
  217.     */
  218.     void removeRelation(Incidence *);
  219.  
  220.  
  221. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  222. // %%%%%  Recurrence-related methods
  223. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  224.  
  225.     /**
  226.       Return the recurrence rule associated with this incidence. If there is
  227.       none, returns an appropriate (non-0) object.
  228.     */
  229.     Recurrence *recurrence() const;
  230.  
  231.     /** Removes all recurrence and exception rules and dates. */
  232.     void clearRecurrence();
  233.  
  234.     /**
  235.       Forward to Recurrence::doesRecur().
  236.     */
  237.     bool doesRecur() const;
  238.     uint recurrenceType() const;
  239.  
  240.     /**
  241.       Returns true if the date specified is one on which the incidence will
  242.       recur.
  243.     */
  244.     virtual bool recursOn( const QDate &qd ) const;
  245.     /**
  246.       Returns true if the date/time specified is one on which the incidence will
  247.       recur.
  248.     */
  249.     bool recursAt( const QDateTime &qdt ) const;
  250.  
  251.     /**
  252.       Calculates the start date/time for all recurrences that happen at some time
  253.       on the given date (might start before that date, but end on or after the
  254.       given date).
  255.       @param date the date where the incidence should occur
  256.       @return the start date/time of all occurences that overlap with the given
  257.           date. Empty list if the incidence does not overlap with the date at all
  258.     */
  259.     virtual QValueList<QDateTime> startDateTimesForDate( const QDate &date ) const;
  260.  
  261.     /**
  262.       Calculates the start date/time for all recurrences that happen at the given
  263.       time.
  264.       @param datetime the date/time where the incidence should occur
  265.       @return the start date/time of all occurences that overlap with the given
  266.           date/time. Empty list if the incidence does not happen at the given
  267.           time at all.
  268.     */
  269.     virtual QValueList<QDateTime> startDateTimesForDateTime( const QDateTime &datetime ) const;
  270.  
  271.     /** Return the end time of the occurrence if it starts at the given date/time */
  272.     virtual QDateTime endDateForStart( const QDateTime &startDt ) const;
  273.  
  274.  
  275. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  276. // %%%%%  Attachment-related methods
  277. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  278.  
  279.     /**
  280.       Add attachment.
  281.     */
  282.     void addAttachment( Attachment *attachment );
  283.     /**
  284.       Remove and delete a specific attachment.
  285.     */
  286.     void deleteAttachment( Attachment *attachment );
  287.     /**
  288.       Remove and delete all attachments with this mime type.
  289.     */
  290.     void deleteAttachments( const QString &mime );
  291.     /**
  292.       Return list of all associated attachments.
  293.     */
  294.     Attachment::List attachments() const;
  295.     /**
  296.       Find a list of attachments with this mime type.
  297.     */
  298.     Attachment::List attachments( const QString &mime ) const;
  299.     /**
  300.       Remove and delete all attachments.
  301.     */
  302.     void clearAttachments();
  303.  
  304.  
  305. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  306. // %%%%%  Secrecy and Status methods
  307. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  308.  
  309.     /**
  310.       Sets secrecy status. This can be Public, Private or Confidential. See
  311.       separate enum.
  312.     */
  313.     void setSecrecy( int );
  314.     /**
  315.       Return the event's secrecy.
  316.     */
  317.     int secrecy() const;
  318.     /**
  319.       Return secrecy as translated string.
  320.     */
  321.     QString secrecyStr() const;
  322.     /**
  323.       Return list of all available secrecy states as list of translated strings.
  324.     */
  325.     static QStringList secrecyList();
  326.     /**
  327.       Return human-readable translated name of secrecy class.
  328.     */
  329.     static QString secrecyName( int );
  330.  
  331.     /**
  332.       Sets the incidence status to a standard status value. See
  333.       separate enum. Note that StatusX cannot be specified.
  334.     */
  335.     void setStatus( Status status );
  336.     /**
  337.       Sets the incidence status to a non-standard status value.
  338.       @param status non-standard status string. If empty,
  339.       the incidence status will be set to StatusNone.
  340.     */
  341.     void setCustomStatus( const QString &status );
  342.     /**
  343.       Return the event's status.
  344.     */
  345.     Status status() const;
  346.     /**
  347.       Return the event's status string.
  348.     */
  349.     QString statusStr() const;
  350.     /**
  351.       Return human-readable translated name of status value.
  352.     */
  353.     static QString statusName( Status );
  354.  
  355.  
  356. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  357. // %%%%%  Other methods
  358. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  359.  
  360.     /**
  361.       Set resources used, such as Office, Car, etc.
  362.     */
  363.     void setResources( const QStringList &resources );
  364.     /**
  365.       Return list of current resources.
  366.     */
  367.     QStringList resources() const;
  368.  
  369.     /**
  370.       Set the incidences priority. The priority has to be a value between 0 and
  371.       9, 0 is undefined, 1 the highest, 9 the lowest priority (decreasing
  372.       order).
  373.     */
  374.     void setPriority( int priority );
  375.     /**
  376.       Return priority. The priority is a number between 1 and 9. 1 is highest
  377.       priority. If the priority is undefined 0 is returned.
  378.     */
  379.     int priority() const;
  380.  
  381.  
  382. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  383. // %%%%%  Alarm-related methods
  384. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  385.  
  386.     /**
  387.       All alarms that are associated with this incidence.
  388.     */
  389.     const Alarm::List &alarms() const;
  390.     /**
  391.       Create a new alarm which is associated with this incidence.
  392.     */
  393.     Alarm *newAlarm();
  394.     /**
  395.       Add an alarm which is associated with this incidence.
  396.     */
  397.     void addAlarm( Alarm * );
  398.     /**
  399.       Remove an alarm that is associated with this incidence.
  400.     */
  401.     void removeAlarm( Alarm * );
  402.     /**
  403.       Remove all alarms that are associated with this incidence.
  404.     */
  405.     void clearAlarms();
  406.     /**
  407.       Return whether any alarm associated with this incidence is enabled.
  408.     */
  409.     bool isAlarmEnabled() const;
  410.  
  411.  
  412. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  413. // %%%%%  Other methods
  414. // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  415.  
  416.  
  417.  
  418.     /**
  419.       Set the event's/todo's location. Do _not_ use it with journal.
  420.     */
  421.     void setLocation(const QString &location);
  422.     /**
  423.       Return the event's/todo's location. Do _not_ use it with journal.
  424.     */
  425.     QString location() const;
  426.  
  427.     /**
  428.       Set the event's/todo's scheduling ID. Does not make sense for journals.
  429.       This is used for accepted invitations as the place to store the UID
  430.       of the invitation. It is later used again if updates to the
  431.       invitation comes in.
  432.       If we did not set a new UID on incidences from invitations, we can
  433.       end up with more than one resource having events with the same UID,
  434.       if you have access to other peoples resources.
  435.     */
  436.     void setSchedulingID( const QString& sid );
  437.     /**
  438.       Return the event's/todo's scheduling ID. Does not make sense for journals
  439.       If this is not set, it will return uid().
  440.     */
  441.     QString schedulingID() const;
  442.  
  443.     /** Observer interface for the recurrence class. If the recurrence is changed,
  444.         this method will be called for the incidence the recurrence object
  445.         belongs to. */
  446.     virtual void recurrenceUpdated( Recurrence * );
  447.   protected:
  448.     /** Return the end date/time of the base incidence (e.g. due date/time for
  449.        to-dos, end date/time for events).
  450.        This method needs to be reimplemented by derived classes. */
  451.     virtual QDateTime endDateRecurrenceBase() const { return dtStart(); }
  452.  
  453.   private:
  454.     int mRevision;
  455.  
  456.     // base components of jounal, event and todo
  457.     QDateTime mCreated;
  458.     QString mDescription;
  459.     QString mSummary;
  460.     QStringList mCategories;
  461.     Incidence *mRelatedTo;
  462.     QString mRelatedToUid;
  463.     Incidence::List mRelations;
  464.     Attachment::List mAttachments;
  465.     QStringList mResources;
  466.  
  467.     QString mStatusString;
  468.     Status  mStatus;
  469.     int mSecrecy;
  470.     int mPriority;                        // 1 = highest, 2 = less, etc.
  471.  
  472.     Alarm::List mAlarms;
  473.     Recurrence *mRecurrence;
  474.  
  475.     QString mLocation;
  476.  
  477.     // Scheduling ID - used only to identify between scheduling mails
  478.     QString mSchedulingID;
  479.  
  480.     class Private;
  481.     Private *d;
  482. };
  483.  
  484. }
  485.  
  486. #endif
  487.